Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Out of place esimd radix sort documentation update #1583

Merged
merged 4 commits into from
May 15, 2024

Conversation

danhoeflinger
Copy link
Contributor

@danhoeflinger danhoeflinger commented May 14, 2024

This PR updates the esimd radix sort documentation with the out of place overloads which were added in #1439.

It also cleans up some minor typos and fixes the namespace in the examples to match their new home after the move.

The memory requirements and performance considerations for out of place overloads should be equivalent to the in place overloads. Out of place overloads run the same kernel code internally, it just provides different input and output sequences to the kernels to allow users to
(1) preserve input sequence order
(2) fold in a copy to an output sequence

@danhoeflinger danhoeflinger changed the title Out of place esimd radix sort documentation update [Docs] Out of place esimd radix sort documentation update May 14, 2024
Copy link
Contributor

@dcbenito dcbenito left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor fixes needed, otherwise LGTM.

Copy link
Contributor

@dmitriy-sobolev dmitriy-sobolev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the documentation update and fixes. I've left several comments.

Signed-off-by: Dan Hoeflinger <[email protected]>
Signed-off-by: Dan Hoeflinger <[email protected]>
@danhoeflinger danhoeflinger force-pushed the dev/dhoeflin/out_of_place_docs branch from 8dcdbae to 40343d9 Compare May 15, 2024 14:07
dcbenito
dcbenito previously approved these changes May 15, 2024
@@ -66,22 +101,25 @@ Parameters
+-----------------------------------------------+---------------------------------------------------------------------+
| Name | Description |
+===============================================+=====================================================================+
| ``q`` | SYCL* queue to submit the kernels to. |
| ``q`` | SYCL* queue to submit the kernels to. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Feedback based on #1559)

Suggested change
| ``q`` | SYCL* queue to submit the kernels to. |
| ``q`` | The SYCL* queue where kernels are submitted. |

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed, thanks

+-----------------------------------------------+---------------------------------------------------------------------+
| | |
| | The sequences of elements to apply the algorithm to. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Feedback based on #1559)

Suggested change
| | The sequences of elements to apply the algorithm to. |
| | The sequences to apply the algorithm to. |

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed, thanks

Signed-off-by: Dan Hoeflinger <[email protected]>
Copy link
Contributor

@dmitriy-sobolev dmitriy-sobolev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@danhoeflinger danhoeflinger merged commit 5229d83 into main May 15, 2024
20 checks passed
@danhoeflinger danhoeflinger deleted the dev/dhoeflin/out_of_place_docs branch May 15, 2024 19:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants